/**
 * <pre>
 * @(#)AbstractView.java 1.00 2009-11-4
 * 
 * Copyright (c) 1998, 2009 Regular Individual. All rights reserved.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *    http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * Contributor(s):
 *     Haixu Huang
 * </pre>
 **/
package cn.sh.huang.chart.view;

import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.event.MouseEvent;

import cn.sh.huang.chart.ext.MouseEventListener;
import cn.sh.huang.chart.view.container.Container;

/**
 * <pre>
 * AbstractView ...
 * 
 * @version 1.0
 * </pre>
 */
public interface AbstractView extends MouseEventListener
{
    /**
     * To render the graphics
     * 
     * @param g2d
     */
    void render(Graphics2D g2d);

    /**
     * @return the preferred(without scroll bar) size of view
     */
    Dimension getPreferredSize();

    /**
     * @return the minimum(with scroll bar) size of view
     */
    Dimension getMinimumSize();

    /**
     * @param width
     * @param height
     */
    void setViewSize(final int width, final int height);

    /**
     * @return view size
     */
    Dimension getViewSize();

    /**
     * Only used by ScrollView to set the anchor of view on the gridRect
     * 
     * @param anchor
     */
    void setGridAnchor(final int x, final int y);

    Point getGridAnchor();

    Point getViewShift();

    Point getViewAnchor();

    Rectangle getViewRect();

    /**
     * @param container
     */
    void setViewContainer(Container container);

    /**
     * To handle the mouse event
     * 
     * @param e
     */
    void processMouseEvent(MouseEvent e);

    /**
     * To return the container of this view 
     * @return
     */
    Container getViewContainer();

    /**
     * GC of view: graphics destroyed, etc.
     */
    void dispose();

    void repaint();

    /**
     * to update the view when something happened
     */
    void update();
}
